Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: improve coding guidelines #1112

Merged
merged 5 commits into from
Feb 21, 2025
Merged

Docs: improve coding guidelines #1112

merged 5 commits into from
Feb 21, 2025

Conversation

jahow
Copy link
Collaborator

@jahow jahow commented Feb 4, 2025

Description

This PR improves the documentation by adding a dedicated "for developers" section with coding guidelines, reorganizing doc sections, and making everything hopefully more readable.

Quality Assurance Checklist

  • Commit history is devoid of any merge commits and readable to facilitate reviews
  • If new logic ⚙️ is introduced: unit tests were added
  • If new user stories 🤏 are introduced: E2E tests were added
  • If new UI components 🕹️ are introduced: corresponding stories in Storybook were created
  • If breaking changes 🪚 are introduced: add the breaking change label
  • If bugs 🐞 are fixed: add the backport <release branch> label
  • The documentation website 📚 has received the love it deserves

Copy link
Contributor

github-actions bot commented Feb 4, 2025

Affected libs:
Affected apps:

  • 🚀 Build and deploy storybook and demo on GitHub Pages
  • 📦 Build and push affected docker images

Copy link
Contributor

github-actions bot commented Feb 4, 2025

📷 Screenshots are here!

Copy link
Collaborator

@cmoinier cmoinier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @jahow for adding so much useful information ! 😃
I think it looks really good. I did notice a small "coquille" (see comment) & I was thinking that maybe we could add details on the libs import dependencies (which libs can/cannot be imported where, to avoid circular dependencies) ? Or maybe it can be done later, that was just an idea !

@jahow
Copy link
Collaborator Author

jahow commented Feb 21, 2025

Thanks @jahow for adding so much useful information ! 😃 I think it looks really good. I did notice a small "coquille" (see comment) & I was thinking that maybe we could add details on the libs import dependencies (which libs can/cannot be imported where, to avoid circular dependencies) ? Or maybe it can be done later, that was just an idea !

Very good idea... That will have to be done in another PR but definitely a very good thing to add!

@jahow
Copy link
Collaborator Author

jahow commented Feb 21, 2025

@cmoinier I ended up documenting the dependencies, hope it's clear enough!

@cmoinier
Copy link
Collaborator

@cmoinier I ended up documenting the dependencies, hope it's clear enough!

Thank you, that looks good!

@jahow jahow merged commit 369bfa6 into main Feb 21, 2025
11 of 12 checks passed
@jahow jahow deleted the improve-coding-guidelines branch February 21, 2025 12:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants